home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / mg2a_src.zip / SYS / AMIGA / AMIGA.DOC < prev    next >
Text File  |  1988-08-23  |  20KB  |  502 lines
  1.  
  2.             Amiga MG 2a Release Notes
  3.             -------------------------
  4.  
  5.    This file attempts to document the Amiga-specific features of MG 2a.
  6. Except where otherwise noted.  It is assumed that you already know
  7. about the point and the mark, buffers, windows, extended commands, and
  8. the various areas on the screen that all versions of MG maintain.  If
  9. you don't, see the MG documentation (what there is of it) for more
  10. information. 
  11.  
  12.                   Amiga Credits
  13.                   -------------
  14.  
  15.   The Amiga Intuition terminal driver is the combined effort of Mike
  16. Meyer and Mic Kaczmarczik.  Others who helped and/or inspired good
  17. ideas for the MG terminal driver include Steve Walton, Leon Frenkel,
  18. Marcus Brooks, and Tom Rokicki.  Steve Walton is also responsible for
  19. the dired mode. Lastly, Bob Larson redesigned the MG keymap system,
  20. making it possible for function keys and mouse clicks to be
  21. ``first-class citizens''.
  22.  
  23.                               OPTIONS
  24.                               -------
  25.  
  26.    This section is for people who have their own C compiler. If you
  27. don't have a C compiler, you will hopefully have a version that has
  28. everything compiled into it. 
  29.  
  30.    There are a bewildering variety of extra goodies available as
  31. compile-time options when you construct an Amiga MG. If you select none
  32. of them, you save on disk and memory space, but lose out on some
  33. features and versatility. 
  34.  
  35.    The Makefile provides documentation on these options and what to do
  36. to make them work, but here is a quick overview:
  37.  
  38.    STARTUP -- You can configure MG so that it will look for a startup
  39. file in either the current directory or the AmigaDOS s: (startup)
  40. directory.  An example startup file is included in the distribution,
  41. and also see the STARTUP section below.
  42.  
  43.    MENU -- If this option is used, MG puts an Intuition menu bar with
  44. major editing commands at the top of the screen, just like a "real"
  45. Amiga program. (See the section on the MENU for more info).
  46.  
  47.    BROWSER -- This has got to be seen to be appreciated. The Browser
  48. program turns the menu bar into a way to select files on a disk. First
  49. you select a disk, then a directory on the disk, then a file or
  50. subdirectory on the disk, and so on, all in the menu. 
  51.  
  52.    MOUSE -- This option turns on the Amiga hot mouse.  You can click
  53. on a character and move point to that spot, and that's just the
  54. beginning. (See the MOUSE section for more.)
  55.  
  56.    FKEYS -- This option turns on support for all the extra Amiga
  57. function keys. This enables the HELP key, which runs the function
  58. "describe-key-briefly". Arrow keys work -- shift-arrow keys apply to
  59. words and paragraphs. (See the KEYBOARD section.)
  60.  
  61.    NO_BACKUP -- This is actually a default option; #defining NO_BACKUP
  62. disables backup files.
  63.  
  64.    When chosen, this #define modifies the action of the save-buffer (C-x
  65. C-s) command.  Normally, save-buffer writes out a new copy of the buffer
  66. to disk, thus destroying the contents of the original file.  If BACKUP
  67. is enabled, MG will rename the file to filename~ (with a tilde character
  68. at the end), before the new copy is written out.  This keeps the
  69. next-to-last copy of your file around on disk, so you can recover from
  70. bad mistakes. 
  71.  
  72.    To avoid filling up disk space too quickly, by default MG does *NOT*
  73. make backup files; to do so, enter the command "M-x make-backup-files",
  74. which enables making backup files the next time you enter C-x C-s to
  75. save a file.  If you give an argument to the function (by typing "C-u
  76. M-x make-backup-files", for example), backup files are not made. 
  77.  
  78.    DO_METAKEY -- When this is enabled, Amiga MG uses the ALT key to
  79. implement the META key found on some terminals.  This means that you
  80. can type ALT-f (in one keystroke) to go forward one word, instead of
  81. ESC-f, which requires two.
  82.  
  83.    CHANGE_FONT -- This allows you to set the font used by the Amiga
  84. console device driver when it draws characters in the MG window.
  85. For instance, this lets you use a slightly taller font for editing
  86. when using interlace mode under 1.2.  MG cannot handle proportionally
  87. spaced fonts, but will allow you to use them (with rather confusing
  88. results) if you really want to.
  89.  
  90.    MODE_RENDITION, {TEXT,MODE}_{FG,BG} -- These are #defines that
  91. determine the default rendition of the mode line and the foreground
  92. and background colors of the text. See the COLOR section for more
  93. info.
  94.  
  95.    CHANGE_COLOR -- If you want to be able to mess around with the
  96. foreground and background colors of the text window, this option
  97. allows you to do that. You can also specify the way the status line is
  98. rendered (plain, boldface, italics, or reverse video).
  99.  
  100.    USE_ARP -- Amiga MG2a uses a few functions which are part of the
  101. library for ARP, the AmigaDOS Replacement Project. Work-alikes for
  102. these routines are provided for those without a copy of arp.library,
  103. but as a future version of Amiga MG will require ARP and it has so
  104. many other redeeming values, it is recommended you obtain a copy.
  105.  
  106.    DO_ICONIFY -- This turns on the ``amiga-iconify'' function,
  107. described in more detail below.
  108.  
  109.                               THE MOUSE
  110.                               ---------
  111.  
  112.    The Amiga Mouse can invoke no less than 24 different functions.
  113. Mouse clicks are essentially treated as keys by the MG, even though you
  114. click the mouse and hold down qualifier keys to get them. 
  115.  
  116.    Mouse keys come in three groups of eight, the groups being:
  117.     Mouse keys        -- when clicked in the text of a window
  118.     Mode-Mouse keys        -- when clicked on a window's mode line
  119.     Echo-Mouse keys        -- when clicked in the echo area
  120.  
  121.    Inside each group, which of the eight keys you get is determined by
  122. the combination of Shift, CTRL and ALT keys you are holding down when
  123. the mouse button is pressed. So yes, there really is a
  124. Ctrl-Meta-Shift-Mode-Mouse button.  Note that the Meta (M-) prefix
  125. *MUST* be the ALT key. Prefixing a mouse click with ESC will not work. 
  126.  
  127.    Mouse keys are generally bound to functions that affect the text in
  128. the selected buffer. If the Intuition mouse pointer is located inside an
  129. MG text window (i.e. an area where text is being edited), then a Mouse
  130. key is sent to the editor when you click the mouse. The buffer
  131. associated wth the window the pointer is in is made current, point is
  132. set as close as possible to the pointer (the character under the
  133. pointer, if possible), then the command bound to that mouse button is
  134. executed. 
  135.  
  136.    If the mouse pointer is in the mode line - the line that is in a
  137. different typeface (usually backlit, maybe black instead of white) --
  138. when the mouse button is clicked, a Mode-Mouse key is sent to the
  139. editor. The buffer that the selected status line is associated with is
  140. made the current buffer, the point is set to the value of point for
  141. that window, then whatever command is bound to that button is
  142. executed. Most of the Mode-Mouse keys invoke functions that act on the
  143. entire window or buffer.
  144.  
  145.    Clicking in the echo line - the line at the bottom of the screen
  146. where prompts and message appear - results in an Echo-Mouse key.
  147. Whatever command is bound to that button will be executed.  Since the
  148. echo line is not part of a buffer or a window, all the functions bound
  149. to Echo-Mouse keys affect the state of the editor as a whole.
  150.    
  151.    The default bindings for the hot mouse (as distributed) are:
  152.  
  153.  Qualifiers  |            Area clicked
  154.              |
  155. C  A  Shift  |    Text window        Mode line    Echo line
  156. -------------+---------------------------------------------------------
  157.          |    dot to mouse        forward page    switch to other buffer 
  158.       X         |    recenter        backward page    kill buffer
  159.    X         |    delete word        split window    describe key
  160.    X  X         |    kill line        delete window    describe bindings
  161. X         |    delete char        goto bob    suspend MG
  162. X     X         |    delete whitespace    goto eob    quit
  163. X  X         |    kill region        enlarge window    list buffers
  164. X  X  X         |    yank            shrink window    toggle Intuition window
  165.  
  166.    To help keep straight what the various keys do, notice that the
  167. Status and Echo groups come in pairs; the shifted version of a key is in
  168. some sense the opposite of the uns